Remote Representation of Parameters Support

Introduction

Since VST 3.5 a new interface is provided: Steinberg::Vst::IXmlRepresentationController

Extended IEditController interface for a component.

A Representation based on XML is a way to export and structure, group Plug-ins parameters for a specific remote (could be hardware or software rack (like quickcontrols)).
It allows to describe more precisely each parameter (what is the best matching to a knob, different titles lengths matching limited remote display,...).
See an Example.


This Representation is implemented as XML text following the Document Type Definition (DTD): http://dtd.steinberg.net/VST-Remote-1.1.dtd

Graphical overview

representation.jpg



Example of implementation using helper class

See Steinberg::Vst::XmlRepresentationHelper.

Location table for VST XMLs Representation

When a host needs to use a VST XMLs Representation (for internal use like Quick-Controls assignment to get the most important parameters sorted per Page of a Plug-in), the host will check the presence in a specific location for a given remote and for this given Plug-in a Representation XML file with the remote name as filename (check below about how the path is defined). If this is not found the host will ask the Plug-in by using Steinberg::Vst::IXmlRepresentationController (if implemented).

Explanation:



For Mac platform:

-------------------------------------------------------------------------------------
Priority  Type      Path
-------------------------------------------------------------------------------------
1         user      $USER/Library/Audio/VST XMLs/$COMPANY/$PLUGIN-NAME/		
2         shared    Library/Audio/VST XMLs/$COMPANY/$PLUGIN-NAME/
3         factory   $PLUGIN-PATH/Contents/Resources/VST XMLs/ 
-------------------------------------------------------------------------------------



For Windows Vista/7 platform:

-------------------------------------------------------------------------------------
Priority  Type      Path
-------------------------------------------------------------------------------------
1         user      Users/$USERNAME/AppData/Roaming]/VST XMLs/$COMPANY/$PLUGIN-NAME/
2         shared    [ProgramData]/VST XMLs/$COMPANY/$PLUGIN-NAME/
3         factory   [$APPFOLDER]/VST XMLs/$COMPANY/$PLUGIN-NAME/
-------------------------------------------------------------------------------------



For Windows XP/2000 platform:

-------------------------------------------------------------------------------------
Priority  Type      Path
-------------------------------------------------------------------------------------
1         user      [Documents and Settings/$USERNAME/Application Data]/VST XMLs/$COMPANY/$PLUGIN-NAME/
2         shared    [Documents and Settings/$ALLUSERS/Application Data]/VST XMLs/$COMPANY/$PLUGIN-NAME/
3         factory   [$APPFOLDER]/VST XMLs/$COMPANY/$PLUGIN-NAME/
-------------------------------------------------------------------------------------


Back to Contents

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.